home *** CD-ROM | disk | FTP | other *** search
/ Gigarom 1 / Gigarom Macintosh Archives (Quantum Leap)(CDRM1080320)(1993).iso / FILES / DEV / C-H / Checksum 1.0.sit / Checksum User’s Manual next >
Text File  |  1993-03-10  |  19KB  |  409 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17. Topics
  18.  
  19. Introduction
  20. System Requirements
  21. Trademarks
  22. License Agreement and Registration Information
  23. The Status Window Display
  24. Usage
  25. Menus
  26. Future enhancements
  27. Questions or Problems?
  28. Registration
  29.  
  30. Introduction
  31.  
  32. Welcome to Checksum for the Macintosh, a complete file checksum program. Checksum is a program that allows anyone to quickly and easily calculate file checksums. Briefly, a checksum is a number calculated for a file by performing some operation on all the characters in the file, such as adding up all the character values and generating a total. A checksum is useful for testing the integrity of a file — the calculated checksum can either be compared against a previously calculated checksum, or the checksum can be compared against a checksum for a file on another computer. Checksum is the easiest way to compare two files on Macintosh computers (either on the same machine or different ones), to tell if they are identical or not! If the checksum values match, there is an extremely good chance the files are identical. The choice of checksum algorithm affects the chance that two files are identical if their checksums match.
  33.  
  34. Some of the key features of Checksum are:
  35.  
  36. •    Most popular checksum algorithms are supported
  37.  
  38. •    Checksum is compatible with most checksum programs on other systems, e.g., the Unix “sum” program and the POSIX.2 “cksum”
  39.  
  40. •    Checksum can specially treat ‘TEXT’ file end-of-line characters to be compatible with Unix or MS-DOS systems
  41.  
  42. •    Checksum is fully System 7 and 32 bit addressing compatible, including balloon help and “drag and drop”
  43.  
  44. •    Checksum is business-ware — free for individuals and for education, but organizations must pay if they use it
  45.  
  46. The results from Checksum are displayed in a window on the screen. Results can be copied to the Clipboard to use in other applications.
  47.  
  48. System Requirements
  49.  
  50. Checksum will run on a Mac Plus or later. System 6 or System 7 is required.
  51.  
  52.  
  53.  
  54.  
  55. Trademarks
  56.  
  57. Apple and Macintosh are registered trademarks of Apple Corp.
  58.  
  59. Unix™ is a registered trademark of Unix System Laboratories, Inc.
  60.  
  61. MS-DOS® is a registered trademark of Microsoft Corp.
  62.  
  63. Sun OS and Solaris are registered trademarks of Sun Microsystems
  64.  
  65. All other trademarks held by their respective owners
  66.  
  67. License Agreement and Registration Information
  68.  
  69. Please read this license carefully before keeping this software. By keeping and/or using the software, you are agreeing to be bound by the terms of this license. If you do not agree to the terms of this license, you are not authorized to use this software and must delete it. Use and distribution of this software is governed by the following terms to reasonably ensure this software will remain freely available and that no one other than the author will derive a commercial benefit from distributing this software.
  70.  
  71. “You,” “your,” and the “user” refers to any person or entity which acquires or uses this software.
  72.  
  73. “Software,” “program” and “application” refers to any computer programs identified at the start of this documentation file, together with all codes, techniques, software tools, formats, designs, concepts, methods, ideas and documentation associated with the computer program(s). The term also includes all copies of any part of the software and documentation.
  74.  
  75. “Author” refers to the author of this software, Geoff Walsh.
  76.  
  77. License: The application and documentation accompanying this License, whether on disk, in read only memory, or on any other media is licensed to you by the author. This software is owned by the author and contains valuable and proprietary information of the author. You own the disk on which the software is recorded.
  78.  
  79. This Checksum program for the Apple Macintosh, and its accompanying documentation, is distributed as businessware. It is freeware for personal use on a single CPU and for educational institutions to use for instructional uses. However, it must be licensed for use within a business, corporation or organization. This includes government agencies. The license fee is $5 U.S. for each computer on which the application is used.
  80.  
  81. If you are a shareware distributor, you may distribute this software as long as you contact the author for permission first. You must distribute all of the files intact and in unmodified form, and may not charge more than a reasonable disk copying fee.
  82.  
  83. This software must be registered using the accompanying registration form and paying the appropriate businessware fees. Individuals using the software for personal use and educational institutions are encouraged to register their copies so they can be informed of future updates.
  84.  
  85. Restrictions: This software and documentation contains copyrighted material, trade secrets and other proprietary material and in order to protect them you may not reverse engineer, decompile, disassemble or otherwise attempt to convert the software to a human-perceivable form. You may not modify, network, rent, lease, loan, distribute or create derivative works based upon this software in whole or in part.
  86.  
  87. Termination: This License is effective until terminated. You may terminate this License at any time by destroying the software and related documentation and all copies thereof. This License will terminate immediately without notice if you fail to comply with any provision of this License. Upon termination you must destroy the software and related documentation and all copies thereof in your possession and cease distributing the same.
  88.  
  89. U. S. Government Restricted Rights: This software is provided with RESTRICTED RIGHTS. Use, duplication or disclosure by the government is subject to restrictions set forth in subparagraph (b)(3)(ii) of The Rights in Technical Data and Computer Software clause at 252.227-7013. Manufacturer is Geoff Walsh, P. O. Box 10, Malibu, California 90265-0010.
  90.  
  91. Disclaimer of Warranty on Software: You expressly acknowledge and agree that use of this software is at your sole risk. The software and related documentation are provided “AS IS” and without warranty of any kind and the author expressly disclaims all warranties, express or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The author does not warrant that the functions contained in the software will meet your requirements, or that the operation of the software will be uninterrupted or error-free, or that defects in the software will be corrected. Furthermore, the author does not warrant or make any representations regarding the use or the results of the use of the software or related documentation in terms of their correctness, accuracy, reliability, or otherwise. No oral or written information or advice given by the author shall create a warranty or in any way increase the scope of this warranty. Should the software prove defective, you assume the entire cost of all necessary servicing, repair or correction. Some states do not allow the exclusion of implied warranties, so the above exclusion may not apply to you.
  92.  
  93. Although the author would appreciate any feedback or bug reports, the author shall not be responsible for correcting any problems which you discover or otherwise help you maintain and use this software. Furthermore, the author may at any time replace, modify, alter, improve, enhance or change this software.
  94.  
  95. Limitation of Liability: Under no circumstances, including negligence, shall the author be liable for any incidental, special or consequential damages that result from the use or inability to use this software or related documentation, even if the author has been advised of the possibility of such damages. Some states do not allow the limitation or exclusion of liability for incidental or consequential damages so the above limitation or exclusion may not apply to you.
  96.  
  97. Controlling Law and Severability: This License shall be governed by and construed in accordance with the laws of the United States and the State of California, as applied to agreements entered into and to be performed entirely within California between California residents. If for any reason a court of competent jurisdiction finds any provision of this License, or portion thereof, to be unenforceable, that provision of the License shall be enforced to the maximum extent permissible so as to effect the intent of the parties, and the remainder of this License shall continue in full force and effect.
  98.  
  99. Complete Agreement: This License constitutes the entire agreement between the parties with respect to the use of this software and related documentation, and supersedes all prior or contemporaneous understandings or agreements, written or oral, regarding such subject matter. No amendment to or modification of this License will be binding unless in writing and signed by a duly authorized representative of the author.
  100.  
  101.  
  102. The Status Window Display
  103.  
  104. The status window is used to display the checksum results. The status window is fully movable and resizable. The display can be scrolled if more information is present than will fit within the window. The status window can only be written by the checksum program — the keyboard cannot add to or modify its contents. However, any information in the status display window can be selected and copied to the Macintosh clipboard.
  105.  
  106. The status window will appear like:
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131. The calculated checksum value is the result as a decimal number. This is what the Checksum application calculates when a file is opened. If a CRC algorithm is used, the result is also shown as a hexadecimal (base 16) value in parentheses.
  132.  
  133. The block count is the number of blocks in the file. This field is mostly for compatibility with the Unix sum program. If the System V checksum algorithm is used, the block size is 512 bytes; for all other checksum algorithms, the block size is 1024 bytes.
  134.  
  135. The byte count is the number of bytes processed during the checksum calculation. Note that this may not be the same as the number of bytes in the file, depending on which file forks are selected and whether ‘TEXT’ file end-of-line translation is set to MS-DOS.
  136.  
  137. The file name is simply the name of the file opened.
  138.  
  139. Usage
  140.  
  141. Here are some possible ways to use Checksum:
  142.  
  143. 1. Compare 2 files to determine whether they are the same or not.
  144.  
  145. Calculate the checksum for each file and compare the results. The files can be on the same system, on different disks, or on two totally different machines (possibly even in different countries). If the checksum for each file is the same, the files are probably the same.
  146.  
  147. Make sure the same checksum algorithm is used on both files. For best results, use any one of the 32-bit CRC options. Also, make sure that both Data fork and Resource fork options are selected.
  148.  
  149. Both files don’t even have to be on Macintosh systems. For example, if one of the files is on a Unix system, the “sum” command can be used to calculate a checksum for one of the files.
  150.  
  151. 2. Determine whether a file has changed over time.
  152.  
  153. If there is a file which may change over time, calculate the checksum for the file and permanently record the results (e.g., with the Save As… option). When you need to determine whether the file has changed, re-calculate the checksum for the file and compare the two calculated values.
  154.  
  155. 3. Calculate the checksum for an entire directory (System 7 users only)
  156.  
  157. Select all the files in the directory, drag the selected files and drop onto the Checksum program icon, using System 7’s “drag and drop” capability. Checksum will calculate the checksum for all files selected. Note that files can be selectively chosen, and even subfolders contents can be selected in an expanded outline view.
  158.  
  159. Menus
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178. The File menu contains all the commands usually associated with opening and saving files:
  179.  
  180. New will open a new status display window. Only one status display window can be open at a time.
  181.  
  182. Open… will open a file and calculate a checksum. Results are presented in the status window. A status window must be active in order to open files to calculate checksums.
  183.  
  184. Close will close the status window.
  185.  
  186. Save As… will save the results in the status window to a file. The file will be a text file which can be opened by an application such as TeachText.
  187.  
  188. Quit will quit the Checksum application.
  189.  
  190. Page Setup… and Print… aren’t implemented in this version of Checksum. If you need to print Checksum results, Copy the status window display to the clipboard, Paste into TeachText, a word processor or text editor, and print.
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208. The Edit menu contains the commands associated with the Macintosh clipboard.
  209.  
  210. Copy will copy the selected text to the clipboard.
  211.  
  212. Select All will select all the results in the status window. The Copy command must still be used to copy all the text to the clipboard.
  213.  
  214. Undo, Cut, Paste and Clear are not valid menu options, but are included for compatibility with desk accessories.
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234. The Options menu controls how the checksum is calculated. The default settings should provide maximum compatibility with the Unix “sum” utility.
  235.  
  236. System V will use the original AT&T Bell Labs checksum algorithm. This is not a very “strong” checksum method, i.e., the chance of identical checksums for different files is greater than for other algorithms. This algorithm is provided mainly for compatibility with System V Unix implementations.
  237.  
  238. BSD will use the checksum algorithm traditionally found on Berkeley 4.x based Unix systems (e.g., Sun OS/Solaris). On System V Unix implementations, the “sum -r” command will usually produce the same values as this option.
  239.  
  240. CRC will use a stronger algorithm than either the System V or BSD options. Cyclic Redundancy Check (CRC) checksums are a family of algorithms. The “CRC Options” submenu is active only when CRC is selected. The “CRC Options” submenu determines which CRC algorithm is used.
  241.  
  242. Data Fork will calculate a checksum value which includes the file’s data fork.
  243.  
  244. Resource Fork will calculate a checksum value which includes the file’s resource fork. For consistency between files, the Finder Information portion of the resource fork (bytes 16 to 127) is ignored in the checksum calculation.
  245.  
  246. Note: when both “Data Fork” and “Resource Fork” are selected, the file is treated as one contiguous file, with the file’s data fork immediately followed by the file’s resource fork. This is not the same as MacBinary format.
  247.  
  248. ‘TEXT’ special determines whether files of type ‘TEXT’ will be treated specially. If ‘TEXT’ special is selected, the Macintosh end-of-line character (carriage return, ASCII value 13, hexadecimal value 0D) will possibly be treated special for ‘TEXT’ files and only the data fork will be used, even if “Resource Fork” is selected. The end-of-line character will be treated as selected in the “End-of-line mode” submenu.
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267. The CRC Options submenu determines which CRC algorithm is used when CRC is selected from the Options menu. Although the 32 bit CRC methods use the same polynomial, initial values are different, which accounts for different results.
  268.  
  269. CRC 16 is the 16 bit CRC algorithm found in applications such as ARC. The CRC polynomial used is: x**16 + x**15 + x**2 + 1.
  270.  
  271. CCITT 16 is the 16 bit CRC algorithm defined by the CCITT international standards group. (CCITT is the Consultive Committee for International Telephone and Telegraph — a standards organization that sets standards for worldwide voice and data communications.) The CRC polynomial used is: x**16 + x**12 + x**5 + 1.
  272.  
  273. Zip 32 is the 32 bit CRC algorithm used in the Zip, Compact Pro and Brik applications. The CRC polynomial used is:
  274. x**32 + x**26 + x**23 + x**22 + x**16 + x**12 + x**11 + x**10 + x**8 + x**7 + x**5 + x**4 + x**2 + x + 1.
  275.  
  276. POSIX.2 is the 32 bit CRC algorithm defined for use in the POSIX.2 “cksum” utility. The CRC polynomial used is:
  277. x**32 + x**26 + x**23 + x**22 + x**16 + x**12 + x**11 + x**10 + x**8 + x**7 + x**5 + x**4 + x**2 + x + 1.
  278. The POSIX.2 CRC algorithm is slightly different from the other CRC algorithms, although the CRC polynomial is the same.
  279.  
  280. CCITT 32 is the 32 bit CRC algorithm defined by the CCITT international standards group. The CRC polynomial used is:
  281. x**32 + x**26 + x**23 + x**22 + x**16 + x**12 + x**11 + x**10 + x**8 + x**7 + x**5 + x**4 + x**2 + x + 1.
  282.  
  283. The Custom 16, Custom 32 and Define… commands aren’t implemented in this version. When implemented, they will support custom CRC calculations.
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296. The End-of-line mode submenu determines how the end-of-line character (carriage return) will be treated when a ‘TEXT’ file is opened if “‘TEXT’ special” has been selected from the Options menu. This will allow ‘TEXT’ files transferred from another operating system to give the same checksum on the Macintosh, even though some end-of-line conversion may have taken place.
  297.  
  298. Macintosh (CR) treats the end-of-line character as is, i.e., there is no conversion.
  299.  
  300. Unix (LF) treats end-of-line characters as a newline character (decimal 10, hexadecimal 0A), instead of as a carriage return. The normal Unix end-of-line character is a line feed. 
  301.  
  302. MS-DOS (CR LF) treats end-of-line characters as a carriage return and line feed pair. This is the normal MS-DOS end-of-line convention.
  303.  
  304.  
  305. Future enhancements
  306.  
  307. This is version 1.0 of Checksum. Depending on support and user feedback, it will be enhanced and maintained.
  308.  
  309. Some of the planned enhancements include:
  310.  
  311. Printing
  312.  
  313. Custom CRC definition and calculation
  314.  
  315. Calculating checksums for all files in a folder, not just individual files
  316.  
  317. Improved user interface for results display
  318.  
  319. Please send suggestions for improvements you would like to see.
  320.  
  321.  
  322. Questions or Problems?
  323.  
  324. Verify that you have a good copy of the program. When you receive Checksum and do Get Info from the Finder’s File menu, you should see:
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352. In its default configuration, checksum will calculate a checksum which should be:
  353. 18684    37 blocks,    37786 bytes “Checksum”
  354.  
  355. If your results don’t match this, your copy has been modified and is not valid.
  356.  
  357. If you have already been using the checksum program, make sure you are using the correct configuration. Remove the “Checksum Preferences” file in your System Folder (System 6) or Preferences folder (System 7).
  358.  
  359. Checksum has been tested on most Macintosh models running both System 6 and System 7 and is 32-bit clean. If you encounter problems, try restarting your computer will all INITs and Extensions disabled. If the problem persists, please contact me. For correspondence by U.S. mail, use:
  360.  
  361. Geoff Walsh
  362. P. O. Box 10
  363. Malibu, CA  90265-0010
  364.  
  365. For electronic correspondence through the Internet, use:    gpw@cerf.net
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.